currentlimit4.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef CURRENTLIMIT4_H
#define CURRENTLIMIT4_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_analog_in.h"
#include "drv_i2c_master.h"




#define CURRENTLIMIT4_SENSITIVITY_A_PER_V       8.0
#define CURRENTLIMIT4_RILIM_DIVIDEND            1460000.0
#define CURRENTLIMIT4_RILIM_OFFSET              110.0

#define CURRENTLIMIT4_ADC_RESOLUTION            0x0FFF
#define CURRENTLIMIT4_VREF_3V3                  3.3
#define CURRENTLIMIT4_VREF_5V                   5.0

#define CURRENTLIMIT4_DIGIPOT_MAX               5000
#define CURRENTLIMIT4_DIGIPOT_RES               256
#define CURRENTLIMIT4_DIGIPOT_R8                330
#define CURRENTLIMIT4_DIGIPOT_OFFSET            110
#define CURRENTLIMIT4_ROUND_TO_NEAREST_INT      0.5

#define CURRENTLIMIT4_ILIMIT_MIN                400
#define CURRENTLIMIT4_ILIMIT_DEFAULT            1000
#define CURRENTLIMIT4_ILIMIT_MAX                3000

#define CURRENTLIMIT4_STEP                      10
#define CURRENTLIMIT4_START_POS                 10
#define CURRENTLIMIT4_MEASURE_NUM               100

#define CURRENTLIMIT4_POWER_GOOD                1
#define CURRENTLIMIT4_POWER_GOOD_ERROR          0

#define CURRENTLIMIT4_SET_DEV_ADDR              0x2E
 // currentlimit4_set



#define CURRENTLIMIT4_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.an  = MIKROBUS( mikrobus, MIKROBUS_AN );    \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL );   \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );   \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS );     \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 // currentlimit4_map // currentlimit4

typedef enum
{
    CURRENTLIMIT4_DRV_SEL_ADC,       
    CURRENTLIMIT4_DRV_SEL_I2C        
 
} currentlimit4_drv_t;

typedef struct
{
    digital_out_t en;       
 
    digital_in_t int_pin;   
 
    analog_in_t  adc;       
    i2c_master_t i2c;       
 
    uint8_t      slave_address;    
    float        vref;             
 
} currentlimit4_t;

typedef struct
{
    pin_name_t an;          
    pin_name_t scl;         
    pin_name_t sda;         
    pin_name_t en;          
    pin_name_t int_pin;     
 
    analog_in_resolution_t resolution;    
    float                  vref;          
    
    uint32_t               i2c_speed;     
    uint8_t                i2c_address;   
 
} currentlimit4_cfg_t;

typedef enum
{
    CURRENTLIMIT4_OK = 0,
    CURRENTLIMIT4_ERROR = -1
 
} currentlimit4_return_value_t;


void currentlimit4_cfg_setup ( currentlimit4_cfg_t *cfg );

err_t currentlimit4_init ( currentlimit4_t *ctx, currentlimit4_cfg_t *cfg );

err_t currentlimit4_default_cfg ( currentlimit4_t *ctx );

void currentlimit4_enable ( currentlimit4_t *ctx );

void currentlimit4_disable ( currentlimit4_t *ctx );

uint8_t currentlimit4_get_power_good ( currentlimit4_t *ctx );

err_t currentlimit4_read_raw_adc ( currentlimit4_t *ctx, uint16_t *raw_adc );

err_t currentlimit4_read_voltage ( currentlimit4_t *ctx, float *voltage );

err_t currentlimit4_set_vref ( currentlimit4_t *ctx, float vref );

err_t currentlimit4_get_current ( currentlimit4_t *ctx, float *current );

err_t currentlimit4_set_wiper_pos ( currentlimit4_t *ctx, uint16_t wiper_pos );

err_t currentlimit4_set_res ( currentlimit4_t *ctx, uint16_t res_ohm );

err_t currentlimit4_set_limit ( currentlimit4_t *ctx, uint16_t ilimit_ma );
 
#ifdef __cplusplus
}
#endif
#endif // CURRENTLIMIT4_H
 // currentlimit4
 
// ------------------------------------------------------------------------ END